Sift API一覧
HTTP仕様(.idPass)
HTTP仕様(.json)
Request header |
Content-Type: application/x-www-form-urlencoded;charset=windows-31j |
|
---|---|---|
Method |
POST |
|
Response header |
Content-Type: text/plain;charset=windows-31j |
|
Status Code |
200:常に200を返却 |
Request header |
Content-Type: application/json;charset=UTF-8 |
|
---|---|---|
Method |
POST |
|
Response header |
Content-Type: application/json;charset=UTF-8 |
|
Status Code |
|
・E90010001
・E92000001
・E92000002
・E91099996
・E91099997
APIの拡張子について
$create_orderイベントの入力パラメータにはARRAY型が含まれています。
APIの拡張子が.jsonの場合は複数項目を指定可能ですが、.idPassの場合は複数項目を指定できませんのでご注意ください。
.idPassの場合は階層構造をとれないため、親パラメータと子パラメータをアンダースコアで接続し送信してください。
$create_orderイベントでのItems(注文商品情報)の例を記載します。
{
"items": [
{
"itemId": "12344321",
"productTitle": "Microwavable Kettle Corn: Original Flavor",
"price": "4990000000",
"currencycode": "JPY",
"quantity": "1",
"upc": "097564307560",
"sku": "03586005",
"brand": "Peters Kettle Corn",
"manufacturer": "Peters Kettle Corn",
"category": "Food and Grocery",
"tags": [
"Popcorn",
"Snacks",
"On Sale"
]
},
{
"itemId": "B004834GQO",
"productTitle": "The Slanket Blanket-Texas Tea",
"price": "39990000",
"currencycode": "JPY",
"quantity": "1",
"upc": "6786211451001",
"sku": "004834GQ",
"brand": "Slanket",
"manufacturer": "Slanket",
"category": "Blankets & Throws",
"tags": [
"Awesome",
"Wintertime specials"
]
}
]
}
Items_ItemId=12344321&Items_ProductTitle=Microwavable Kettle Corn: Original Flavor&Items_Price=4990000000&Items_CurrencyCode=JPY&&Items_Quantity=1&Items_Upc=097564307560&Items_Sku=03586005&Items_Brand=Peters Kettle Corn&Items_Manufacturer=Peters Kettle Corn&Items_Category=Food and Grocery&Items_Tags=Popcorn
SiftEvents($create_order) 決済前スコア判定
決済前にスコア判定を実施します。イベントタイプに$create_orderを設定します。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||||||
---|---|---|---|---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||||||
Type | type | 必須 半角英数記号13桁
イベントタイプ「$create_order」を設定します。 |
||||||
UserId | userId | 必須 半角英数記号500桁
ユーザID Siftにデバイス情報を送信する際に設定した_user_idを設定します。 |
||||||
SessionId | sessionId | 半角英数記号500桁
セッションID Siftにデバイス情報を送信する際に設定した_session_idを設定します。 |
||||||
OrderID | orderID | 半角英数記号27桁
オーダーID
|
||||||
UserEmail | userEmail |
ユーザメールアドレスお客様のメールアドレスを設定します。 |
||||||
MemberID | memberID | 半角英数60桁
会員ID 決済する対象の会員IDを設定します。 |
||||||
SiteID | siteID | 半角英数13桁
サイトID会員IDを指定している場合、必須になります。 |
||||||
SitePass | sitePass | 半角英数10桁
サイトパスワード会員IDを指定している場合、必須になります。 |
||||||
SeqMode | seqMode | 半角数字1桁
カード登録連番モード 以下のいずれかを設定します。 |
||||||
CardSeq | cardSeq | 半角数字4桁
カード登録連番 決済に使用するカード登録連番を設定します。 |
||||||
Token | token | 半角英数記号512桁
トークン カード番号トークン化サービスをご利用の場合、取得したトークンを設定します。 |
||||||
Amount | amount |
金額 総取引額を、通貨コードで指定した基本単位をマイクロで設定します。 |
||||||
CurrencyCode | currencyCode |
通貨コード ISO-4217に基づく、金額の通貨コードを設定します。 |
||||||
BillingAddress | billingAddress |
請求先住所お客様が入力された請求先住所を設定します。 |
||||||
Name | name |
氏名 住所に関連付けられている氏名を設定します。 |
||||||
Address1 | address1 |
番地_1行目 番地の1行目を設定します。 |
||||||
Address2 | address2 |
番地_2行目 番地の2行目を設定します。 |
||||||
City | city |
市町村 市町村を設定します。 |
||||||
Region | region |
都道府県 都道府県を設定します。 |
||||||
Country | country |
国 ISO-3166に基づく、国コードを設定します。 |
||||||
Zipcode | zipcode |
郵便番号 郵便番号を設定します。 |
||||||
Phone | phone |
電話番号 電話番号をE.164形式又は番号の発信元の標準的な国内形式で設定します。 |
||||||
PaymentMethods | paymentMethods |
支払い情報注文に関連付けられている支払い情報の配列を設定します。 |
||||||
PaymentType | paymentType |
支払い方法 クレジットカード決済の場合「$credit_card」、代引き決済の場合「$cash」を設定します。 |
||||||
CardBin | cardBin |
銀行識別番号 クレジットカード番号の上六桁を設定します。 |
||||||
CardLast4 | cardLast4 |
カード番号下四桁 クレジットカード番号の下四桁を設定します。 |
||||||
ShippingAddress | shippingAddress |
配送先住所お客様が入力された配送先住所を設定します。 |
||||||
Name | name |
氏名 住所に関連付けられている氏名を設定します。 |
||||||
Address1 | address1 |
番地_1行目 番地の1行目を設定します。 |
||||||
Address2 | address2 |
番地_2行目 番地の2行目を設定します。 |
||||||
City | city |
市町村 市町村を設定します。 |
||||||
Region | region |
都道府県 都道府県を設定します。 |
||||||
Country | country |
国 ISO-3166に基づく、国コードを設定します。 |
||||||
Zipcode | zipcode |
郵便番号 郵便番号を設定します。 |
||||||
Phone | phone |
電話番号 電話番号をE.164形式又は番号の発信元の標準的な国内形式で設定します。 |
||||||
ExpeditedShipping | expeditedShipping |
優先/迅速配送リクエストフラグ お客様が注文の優先/迅速配送をリクエストされたかを設定します。 |
||||||
Items | items |
注文商品情報 注文された商品の情報を設定します。 |
||||||
ItemId | itemId |
商品ID 商品を識別するIDを設定します。 |
||||||
ProductTitle | productTitle |
商品名 商品名を設定します。 |
||||||
Price | price |
商品単価 商品単価を、通貨コードで指定した基本単位をマイクロで設定します。 |
||||||
CurrencyCode | currencyCode |
商品単価通貨コード ISO-4217に基づく、金額の通貨コードを設定します。 |
||||||
Quantity | quantity |
商品数商品の数量を設定します。 |
||||||
Upc | upc |
ユニバーサル・プロダクト・コードユニバーサル・プロダクト・コード(UPC)またはJANコードを設定します。 |
||||||
Sku | sku |
ストック・キーピング・ユニットストック・キーピング・ユニット(SKU)IDを設定します。 |
||||||
Isbn | isbn |
国際標準図書番号商品が国際標準図書番号(ISBN)のある本である場合に設定します。 |
||||||
Brand | brand |
ブランド名商品のブランド名を設定します。 |
||||||
Manufacturer | manufacturer |
メーカー名商品のメーカー名を設定します。 |
||||||
Category | category |
カテゴリ名 加盟店様のビジネスが対象商品に設定しているカテゴリを設定します。 |
||||||
Tags | tags |
タグ名 加盟店様のビジネスが対象商品を説明する為に使用されるタグを設定します。 |
||||||
Color | color |
商品の色商品の色を設定します。 |
||||||
Size | size |
商品のサイズ商品のサイズを設定します。 |
||||||
Bookings | bookings |
予約注文情報 行われた予約の情報を設定します。 |
||||||
BookingType | bookingType |
予約種別 予約の種別を設定します。 |
||||||
Title | title |
説明予約内容の説明を設定します。 |
||||||
StartTime | startTime |
開始日時 予約内容の開始日時を設定します。 |
||||||
EndTime | endTime |
終了日時 予約内容の終了日時を設定します。 |
||||||
Price | price |
価格予約の価格を設定します。 |
||||||
CurrencyCode | currencyCode |
予約通貨コード ISO-4217に基づく、金額の通貨コードを設定します。 |
||||||
Quantity | quantity |
予約数 予約数を設定します。 |
||||||
Guests | guests |
お客様情報予約したお客様の情報を設定します。 |
||||||
Name | name |
予約者名予約したお客様の名前を設定します。 |
||||||
お客様メールアドレス予約したお客様のメールアドレスを設定します。 |
||||||||
Phone | phone |
お客様電話番号予約したお客様の電話番号をE.164形式又は番号の発信元の標準的な国内形式で設定します。 |
||||||
LoyaltyProgram | loyaltyProgram |
ロイヤリティプログラム名予約したお客様が使用するロイヤリティプログラムの名前を設定します。 |
||||||
LoyaltyProgramId | loyaltyProgramId |
ロイヤリティプログラムメンバーシップID予約したお客様が使用するロイヤリティプログラムのメンバーシップIDを設定します。 |
||||||
BirthDate | birthDate |
生年月日YYYYMMDD又はYYYY-MM-DD形式で、予約したお客様の生年月日を設定します。 |
||||||
EventId | eventId |
イベントIDイベントを示すIDを設定します。 |
||||||
VenueId | venueId |
会場ID予約対象を示すIDを設定します。 |
||||||
Location | location |
会場住所 予約対象の住所を設定します。 |
||||||
Name | name |
氏名 住所に関連付けられている氏名を設定します。 |
||||||
Address1 | address1 |
番地_1行目 番地の1行目を設定します。 |
||||||
Address2 | address2 |
番地_2行目 番地の2行目を設定します。 |
||||||
City | city |
市町村 市町村を設定します。 |
||||||
Region | region |
都道府県 都道府県を設定します。 |
||||||
Country | country |
国 ISO-3166に基づく、国コードを設定します。 |
||||||
Zipcode | zipcode |
郵便番号 郵便番号を設定します。 |
||||||
Phone | phone |
電話番号 電話番号をE.164形式又は番号の発信元の標準的な国内形式で設定します。 |
||||||
Category | category |
カテゴリ予約のカテゴリを設定します。 |
||||||
Tags | tags |
タグ予約対象のタグを設定します。 |
||||||
RoomType | roomType |
部屋タイプ 部屋のタイプを設定します。 |
||||||
Segments | segments |
旅程情報旅程について設定します。 |
||||||
DepartureAddress | departureAddress |
出発地点住所 旅の出発地点の住所を設定します。 |
||||||
Name | name |
氏名 住所に関連付けられている氏名を設定します。 |
||||||
Address1 | address1 |
番地_1行目 番地の1行目を設定します。 |
||||||
Address2 | address2 |
番地_2行目 番地の2行目を設定します。 |
||||||
City | city |
市町村 市町村を設定します。 |
||||||
Region | region |
都道府県 都道府県を設定します。 |
||||||
Country | country |
国 ISO-3166に基づく、国コードを設定します。 |
||||||
Zipcode | zipcode |
郵便番号 郵便番号を設定します。 |
||||||
Phone | phone |
電話番号 電話番号をE.164形式又は番号の発信元の標準的な国内形式で設定します。 |
||||||
ArrivalAddress | arrivalAddress |
到着地点住所 旅の到着地点の住所を設定します。 |
||||||
Name | name |
氏名 住所に関連付けられている氏名を設定します。 |
||||||
Address1 | address1 |
番地_1行目 番地の1行目を設定します。 |
||||||
Address2 | address2 |
番地_2行目 番地の2行目を設定します。 |
||||||
City | city |
市町村 市町村を設定します。 |
||||||
Region | region |
都道府県 都道府県を設定します。 |
||||||
Country | country |
国 ISO-3166に基づく、国コードを設定します。 |
||||||
Zipcode | zipcode |
郵便番号 郵便番号を設定します。 |
||||||
Phone | phone |
電話番号 電話番号をE.164形式又は番号の発信元の標準的な国内形式で設定します。 |
||||||
StartTime | startTime |
出発時間 旅の出発時間を設定します。 |
||||||
EndTime | endTime |
到着時間 旅の到着時間を設定します。 |
||||||
VesselNumber | vesselNumber |
移動手段番号 旅を識別する為の番号を設定します。 |
||||||
DepartureAirportCode | departureAirportCode |
出発空港IATAコード 出発する空港のIATAコードを設定します。 |
||||||
ArrivalAirportCode | arrivalAirportCode |
到着空港IATAコード 到着する空港のIATAコードを設定します。 |
||||||
FareClass | fareClass |
旅行クラス 旅行のクラスを設定します。 |
||||||
SellerUserId | sellerUserId |
販売者 マーケットプレイスビジネスの場合、売り手のユーザIDを設定します。 |
||||||
Promotions | promotions |
プロモーション紹介、クーポン、無料試用等のプロモージョンの情報を設定します。 |
||||||
PromotionId | promotionId |
プロモーションID プロモーションを表す為に使用するIDを設定します。 |
||||||
Status | status |
プロモーションステータス プロモーションの追加成否を設定します。 |
||||||
FailureReason | failureReason |
プロモーション追加失敗理由 プロモーションの追加失敗理由を設定します。 |
||||||
Description | description |
プロモーション説明プロモーションの説明を設定します。 |
||||||
ReferrerUserId | referrerUserId |
紹介者ユーザID お客様をこのプロモーションに紹介したユーザのIDを設定します。 |
||||||
Discount | discount |
金銭的割引情報プロモーションによる金銭的割引を設定します。 |
||||||
PercentageOff | percentageOff |
割引率 割引率を設定します。 |
||||||
Amount | amount |
金額割引金額を、通貨コードで指定した基本単位をマイクロで設定します。 |
||||||
CurrencyCode | currencyCode |
割引金額通貨コード ISO-4217に基づく、金額の通貨コードを設定します。 |
||||||
MinimumPurchaseAmount | minimumPurchaseAmount |
プロモーション適用最低金額 プロモーションの適用に必要な最低金額を通貨コードで指定した基本単位をマイクロで設定します。 |
||||||
CreditPoint | creditPoint |
クレジットポイントプロモーションによる金銭的及び非金銭的な報酬を設定します。 |
||||||
Amount | amount |
クレジットポイント値プロモーションにおけるクレジットポイントの量を設定します。 |
||||||
CreditPointType | creditPointType |
クレジットポイントタイプ クレジットポイントのタイプについて設定します。 |
||||||
ShippingMethod | shippingMethod |
配送方法 お客様への配送方法を設定します。 |
||||||
Browser | browser |
ブラウザ情報 お客様端末のユーザーエージェントを設定します。 |
||||||
UserAgent | userAgent |
ユーザーエージェントブラウザのユーザーエージェントを設定します。 |
||||||
App | app |
アプリ情報お客様端末のアプリ、OS、デバイス情報を設定します。ブラウザ情報と組み合わせて使用することは出来ません。 |
||||||
Os | os |
OS お客様がアプリケーションを実行しているOSを設定します。 |
||||||
OsVersion | osVersion |
OSバージョン お客様がアプリケーションを実行しているOSを設定します。 |
||||||
DeviceManufacturer | deviceManufacturer |
デバイス製造元 お客様がアプリケーションを実行しているデバイスの製造元を設定します。 |
||||||
DeviceModel | deviceModel |
デバイスのモデル お客様がアプリケーションを実行しているデバイスのモデルを設定します。 |
||||||
DeviceUniqueId | deviceUniqueId |
デバイスID お客様がアプリケーションを実行しているデバイスを判別するIDを設定します。 |
||||||
AppName | appName |
アプリケーション名お客様が実行しているアプリケーション名を設定します。 |
||||||
AppVersion | appVersion |
アプリケーションバージョンお客様が実行しているアプリケーションのバージョンを設定します。 |
||||||
SiftOrderID | siftOrderID | 半角英数記号45桁
SiftオーダーID 実行済のイベントに対し再度実行する場合に設定します。 |
||||||
ClientField1 | clientField1 | 全半角100バイト
加盟店自由項目1
|
||||||
ClientField2 | clientField2 | 全半角100バイト
加盟店自由項目2
|
||||||
ClientField3 | clientField3 | 全半角100バイト
加盟店自由項目3
|
||||||
Ip | ip | 半角英数記号39桁
IPアドレス ユーザのIPアドレスを設定します。 |
※1:銀行識別番号、カード番号下四桁は以下の優先順位でセットされSiftへ送信されます。
①銀行識別番号(CardBin)、カード番号下四桁(CardLast4)で指定された値
②会員IDに紐づくカード番号
③トークンを複合化したカード番号
※2:設定可能な文字は半角英数字及び . - _+ @ : ^ % ! $ になります。
/payment/SiftEvents.json
{
"shopID": "tshop11223344",
"shopPass": "xxxxxxxx",
"type": "$create_order",
"userId": "billy_jones_301",
"sessionId": "gigtleqddo84l8cm15qe4il",
"orderID": "ORDER0000001",
"userEmail": "bill@gmail.com",
"amount": "115940000",
"currencyCode": "USD",
"billingAddress": {
"name": "Bill Jones",
"address1": "2100 Main Street",
"address2": "Apt 3B",
"city": "New London",
"region": "New Hampshire",
"country": "US",
"zipcode": "03257",
"phone": "1-415-555-6041"
},
"paymentMethods": [
{
"paymentType": "$credit_card",
"cardBin": "542486",
"cardLast4": "4444"
}
],
"shippingAddress": {
"name": "Bill Jones",
"address1": "2100 Main Street",
"address2": "Apt 3B",
"city": "New London",
"region": "New Hampshire",
"country": "US",
"zipcode": "03257",
"phone": "1-415-555-6041"
},
"expeditedShipping": "true",
"shippingMethod": "$physical",
"items": [
{
"itemId": "12344321",
"productTitle": "Microwavable Kettle Corn: Original Flavor",
"price": "4990000000",
"upc": "097564307560",
"sku": "03586005",
"brand": "Peters Kettle Corn",
"manufacturer": "Peters Kettle Corn",
"category": "Food and Grocery",
"tags": [
"Popcorn",
"Snacks",
"On Sale"
]
},
{
"itemId": "B004834GQO",
"productTitle": "The Slanket Blanket-Texas Tea",
"price": "39990000",
"upc": "6786211451001",
"sku": "004834GQ",
"brand": "Slanket",
"manufacturer": "Slanket",
"category": "Blankets & Throws",
"tags": [
"Awesome",
"Wintertime specials"
]
}
],
"sellerUserId": "slinkys_emporium",
"promotions": [
{
"promotionId": "FirstTimeBuyer",
"status": "$success",
"description": "$5 off",
"discount": {
"amount": "5000000",
"currencyCode": "USD",
"minimumPurchaseAmount": "25000000"
}
}
],
"browser": {
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36"
}
}
/payment/SiftEvents.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&Type=$create_order&UserId=billy_jones_301&SessionId=gigtleqddo84l8cm15qe4il&OrderID=ORDER0000001&UserEmail=bill@gmail.com&Amount=1000000000&CurrencyCode=USD&BillingAddress_Name=Bill Jones&BillingAddress_Address1=2100 Main Street&BillingAddress_Address2=Apt 3B&BillingAddress_City=New London&BillingAddress_Region=New Hampshire&BillingAddress_Country=US&BillingAddress_Zipcode=03257&BillingAddress_Phone=1-415-555-6041&PaymentMethods_PaymentType=$credit_card&PaymentMethods_CardBin=542486&PaymentMethods_CardLast4=4444&ShippingAddress_Name=Bill Jones&ShippingAddress_Address1=2100 Main Street&ShippingAddress_Address2=Apt 3B&ShippingAddress_City=New London&ShippingAddress_Region=New Hampshire&ShippingAddress_Country=US&ShippingAddress_Zipcode=03257&ShippingAddress_Phone=1-415-555-6041&ExpeditedShipping=true&ShippingMethod=$physical&Items_ItemId=12344321&Items_ProductTitle=Microwavable Kettle Corn: Original Flavor&Items_Price=4990000000&Items_CurrencyCode=JPY&&Items_Quantity=1&Items_Upc=097564307560&Items_Sku=03586005&Items_Brand=Peters Kettle Corn&Items_Manufacturer=Peters Kettle Corn&Items_Category=Food and Grocery&Items_Tags=Popcorn&SellerUserId=slinkys_emporium&Promotions_PromotionId=FirstTimeBuyer&Promotions_Status=$success&Promotions_Description=$5 off&Promotions_Discount_Amount=5000000&Promotions_Discount_CurrencyCode=USD&Promotions_Discount_MinimumPurchaseAmount=25000000&Browser_UserAgent=Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36
レスポンス
正常
SiftOrderID | siftOrderID | 必須 半角英数記号45桁
SiftオーダーIDSiftオーダーIDを指定した場合はその値を、指定していない場合は新たに発行した値を返却します。 |
||
---|---|---|---|---|
PaymentAbuseScore | paymentAbuseScore | 必須 半角数字3桁
決済不正使用スコア0から100の間の整数値で判定結果を返却します。 |
{
"siftOrderID": "20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a",
"paymentAbuseScore": "34"
}
SiftOrderID=20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a&PaymentAbuseScore=34
{
"errCode":"E01",
"errInfo":"E01040001"
}
ErrCode=E01&ErrInfo=E01040001
SiftEvents($transaction) 決済後スコア判定
決済後にスコア判定を実施します。イベントタイプに$transactionを設定します。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||
Type | type | 必須 半角英数記号13桁
イベントタイプ「$transaction」を設定します。 |
||
OrderID | orderID | 半角英数記号27桁
オーダーID 決済時の【取引登録】で指定した値を設定します。SiftオーダーIDを指定した場合必須ではありませんが取引との紐付けがされませんので、可能な限りオーダーIDを指定してすることを推奨します。 |
||
MemberID | memberID | 半角英数60桁
会員ID 決済する対象の会員IDを設定します。会員情報を基に銀行識別番号、カード番号下四桁を設定します。 |
||
SiteID | siteID | 半角英数13桁
サイトID会員IDを指定している場合、必須になります。 |
||
SitePass | sitePass | 半角英数10桁
サイトパスワード会員IDを指定している場合、必須になります。 |
||
SeqMode | seqMode | 半角数字1桁
カード登録連番モード 以下のいずれかを設定します。 |
||
CardSeq | cardSeq | 半角数字4桁
カード登録連番 決済に使用するカード登録連番を設定します。 |
||
Token | token | 半角英数512桁
トークン カード番号トークン化サービスをご利用の場合、取得したトークンを設定します。トークンを基に銀行識別番号、カード番号下四桁をセットします。 |
||
TransactionType | transactionType |
取引区分 取引区分を設定します。 |
||
TransactionStatus | transactionStatus |
取引ステータス 取引のステータスを設定します。 |
||
DeclineCategory | declineCategory |
取引エラー理由 取引のエラー理由を設定します。取引ステータスに$failureを指定した場合のみ設定が可能です。 |
||
SiftOrderID | siftOrderID | 半角英数記号45桁
SiftオーダーID$create_orderにて返却されたSiftオーダーIDを設定します。オーダーID・決済手段を指定した場合は必須ではありません。 |
||
ClientField1 | clientField1 | 全半角100バイト
加盟店自由項目1
|
||
ClientField2 | clientField2 | 全半角100バイト
加盟店自由項目2
|
||
ClientField3 | clientField3 | 全半角100バイト
加盟店自由項目3
|
||
PayType | payType |
決済手段 使用した決済手段を設定します。 |
||
Ip | ip | 半角英数記号39桁
IPアドレス ユーザのIPアドレスを設定します。 |
||
以下のパラメータは決済前スコア判定($create_order)の値を自動で設定し、Siftへ送信します。 |
||||
UserId | userId | 半角英数記号500桁
ユーザID Siftにデバイス情報を送信する際に設定した_user_idを設定します。 |
||
SessionId | sessionId | 半角英数記号500桁
セッションID セッションID Siftにデバイス情報を送信する際に設定した_session_idを設定します。 |
||
UserEmail | userEmail |
ユーザメールアドレスお客様のメールアドレスを設定します。 |
||
Amount | amount |
金額 総取引額を、通貨コードで指定した基本単位をマイクロで設定します。 |
||
CurrencyCode | currencyCode |
通貨コード ISO-4217に基づく、金額の通貨コードを設定します。 |
||
BillingAddress | billingAddress |
請求先住所お客様が入力された請求先住所を設定します。 |
||
Name | name |
氏名住所に関連付けられている氏名を設定します。姓と名は連結して設定します。 |
||
Address1 | address1 |
番地_1行目 番地の1行目を設定します。 |
||
Address2 | address2 |
番地_2行目 番地の2行目を設定します。 |
||
City | city |
市町村 市町村を設定します。 |
||
Region | region |
都道府県 都道府県を設定します。 |
||
Country | country |
国 ISO-3166に基づく、国コードを設定します。 |
||
Zipcode | zipcode |
郵便番号 郵便番号を設定します。 |
||
Phone | phone |
電話番号 電話番号をE.164形式又は番号の発信元の標準的な国内形式で設定します。 |
||
PaymentMethod | paymentMethod |
支払い情報注文に関連付けられている支払い情報を設定します。決済前スコア判定のPaymentMethods(ARRAY)の1番目の項目が引き継がれます。 |
||
PaymentType | paymentType |
支払い方法 クレジットカード決済の場合「$credit_card」、代引き決済の場合「$cash」を設定します。 |
||
CardBin | cardBin |
銀行識別番号 クレジットカード番号の上六桁を設定します。 |
||
CardLast4 | cardLast4 |
カード番号下四桁 クレジットカード番号の下四桁を設定します。 |
||
ShippingAddress | shippingAddress |
配送先住所お客様が入力された配送先住所を設定します。 |
||
Name | name |
氏名住所に関連付けられている氏名を設定します。姓と名は連結して設定します。 |
||
Address1 | address1 |
番地_1行目 番地の1行目を設定します。 |
||
Address2 | address2 |
番地_2行目 番地の2行目を設定します。 |
||
City | city |
市町村 市町村を設定します。 |
||
Region | region |
都道府県 都道府県を設定します。 |
||
Country | country |
国 ISO-3166に基づく、国コードを設定します。 |
||
Zipcode | zipcode |
郵便番号 郵便番号を設定します。 |
||
Phone | phone |
電話番号 電話番号をE.164形式又は番号の発信元の標準的な国内形式で設定します。 |
||
SellerUserId | sellerUserId |
販売者 マーケットプレイスビジネスの場合、売り手のユーザIDを設定します。通常はデータベースの主キーです。 |
||
Browser | browser |
ブラウザ情報お客様端末のユーザーエージェントを設定します。アプリ情報と組み合わせて使用することはできません。 |
||
UserAgent | userAgent |
ユーザーエージェントブラウザのユーザーエージェントを設定します。 |
||
App | app |
アプリ情報お客様端末のアプリ、OS、デバイス情報を設定します。ブラウザ情報と組み合わせて使用することはできません。 |
||
Os | os |
OS お客様がアプリケーションを実行しているOSを設定します。 |
||
OsVersion | osVersion |
OSバージョン お客様がアプリケーションを実行しているOSを設定します。 |
||
DeviceManufacturer | deviceManufacturer |
デバイス製造元 お客様がアプリケーションを実行しているデバイスの製造元を設定します。 |
||
DeviceModel | deviceModel |
デバイスのモデル お客様がアプリケーションを実行しているデバイスのモデルを設定します。 |
||
DeviceUniqueId | deviceUniqueId |
デバイスIDお客様がアプリケーションを実行しているデバイスを判別するIDを設定します。iOSの場合はIFVを、Androidの場合はAndroid IDを送信します。 |
||
AppName | appName |
アプリケーション名お客様が実行しているアプリケーション名を設定します。 |
||
AppVersion | appVersion |
アプリケーションバージョンお客様が実行しているアプリケーションのバージョンを設定します。 |
※1:オーダーID、決済手段を指定した場合、取引の情報を取得し自動で設定されます。
(表 決済手段ごとの自動設定パラメータ 参照)
※2:各パラメータは以下の優先順位でセットされSiftへ送信されます。
①$transactionにて指定された値
②$transactionにて指定された会員IDに紐づくカード番号
③$transactionにて指定されたトークンを複合化したカード番号
④$create_orderにて指定された値
⑤$transactionにて指定されたオーダーID、決済手段から取得した取引情報
※3:※2のいずれにおいても金額、通貨コードが設定されていない場合はエラーです。
※4:設定可能な文字は半角英数字及び . - _+ @ : ^ % ! $ になります。
決済手段 | 設定されるパラメータ | 設定値 |
---|---|---|
共通 | 金額(Amount) | 取引の金額が設定されます。 |
通貨コード(CurrencyCode) | 「JPY」が設定されます。 | |
取引ステータス(TransactionStatus) | 取引の現状態を基に設定されます。 成功:$success 失敗:$failure 上記以外:$pending |
|
Credit | 銀行識別番号(PayMethod.CardBin) | 取引のカード番号が設定されます。 |
カード番号下四桁(PayMethod.CardLast4) | 取引のカード番号が設定されます。 | |
取引区分(TransactionType) | 取引の処理区分を基に設定されます。 SALES:$sale AUTH:$authorize CAPTURE:$capture VOID:$void |
|
支払い方法(PaymentType) | 「$credit_card」が設定されます。 | |
Cvs | ユーザメールアドレス(UserEmail) | 取引の結果通知先メールアドレスが設定されます。 |
氏名(BillingAddress.Name) | 取引の氏名が設定されます。 | |
電話番号(BillingAddress.Phone) | 取引の電話番号が設定されます。 | |
Dcc | 通貨コード(CurrencyCode) | 取引の通貨コードが設定されます。 |
銀行識別番号(PayMethod.CardBin) | 取引のカード番号が設定されます。 | |
カード番号下四桁(PayMethod.CardLast4) | 取引のカード番号が設定されます。 | |
支払い方法(PaymentType) | 「$credit_card」が設定されます。 | |
AuContinuance | 金額(Amout) | 取引の初回決済金額が設定されます。 |
Linepay | 電話番号(ShippingAddress.Phone) | 取引の受取人連絡先が設定されます。 |
Unionpay | 支払い方法(PaymentType) | 「$credit_card」が設定されます。 |
/payment/SiftEvents.json
{
"shopID":"tshop11223344",
"shopPass":"PASSWORD",
"type":"$transaction",
"orderID":"ORDER0000001",
"payType":"Credit"
}
/payment/SiftEvents.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&Type=$transaction&OrderID=ORDER0000001&PayType=Credit
レスポンス
正常
SiftOrderID | siftOrderID | 必須 半角英数記号45桁
SiftオーダーID対象トランザクションのSiftオーダーIDを返却します。 |
||
---|---|---|---|---|
PaymentAbuseScore | paymentAbuseScore | 必須 半角数字3桁
決済不正使用スコア0から100の間の整数値で判定結果を返却します。 |
{
"siftOrderID": "20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a",
"paymentAbuseScore": "34"
}
SiftOrderID=20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a&PaymentAbuseScore=34
{
"errCode":"E01",
"errInfo":"E01040001"
}
ErrCode=E01&ErrInfo=E01040001
SiftEvents($chargeback) チャージバック情報連携
チャージバック情報を連携します。イベントタイプに$chargebackを設定します。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||
Type | type | 必須 半角英数記号13桁
イベントタイプ「$chargeback」を設定します。 |
||
UserId | userId | 半角英数記号500桁
ユーザID Siftにデバイス情報を送信する際に設定した_user_idを設定します。 |
||
OrderID | orderID | 半角英数記号27桁
オーダーID $transactionイベント実行時のオーダーIDを設定します。 |
||
ChargebackState | chargebackState |
チャージバックの現在の状態 チャージバックの現在の状態を設定します。 |
||
ChargebackReason | chargebackReason |
チャージバック理由 チャージバックの理由を設定します。 |
||
SiftOrderID | siftOrderID | 半角英数記号45桁
SiftオーダーID $transactionイベント実行時のSiftオーダーIDを設定します。 |
||
ClientField1 | clientField1 | 全半角100バイト
加盟店自由項目1
|
||
ClientField2 | clientField2 | 全半角100バイト
加盟店自由項目2
|
||
ClientField3 | clientField3 | 全半角100バイト
加盟店自由項目3
|
※1:$transaction実行時のオーダーID、SiftオーダーIDのいずれかを指定してください。
ユーザIDを指定しない場合は、最新のユーザIDが設定されます。
/payment/SiftEvents.json
{
"shopID":"tshop11223344",
"shopPass":"PASSWORD",
"type":"$chargeback",
"chargebackState":"$lost",
"chargebackReason":"$duplicate",
"siftOrderID":"20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a3"
}
/payment/SiftEvents.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&Type=$chargeback&ChargebackState=$lost&ChargebackReason=$duplicate&SiftOrderID=20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a3
レスポンス
正常
SiftOrderID | siftOrderID | 必須 半角英数記号45桁
SiftオーダーID対象のSiftオーダーIDを返却します。 |
||
---|---|---|---|---|
PaymentAbuseScore | paymentAbuseScore | 必須
決済不正使用スコア値は返却されません。 |
{
"siftOrderID": "20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a",
"paymentAbuseScore": ""
}
SiftOrderID=20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a&PaymentAbuseScore=
{
"errCode":"E01",
"errInfo":"E01040001"
}
ErrCode=E01&ErrInfo=E01040001
SiftEvents($decision) 取引判断結果連携
取引の判断結果を連携します。イベントタイプに$decisionを設定します。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||
Type | type | 必須 半角英数記号13桁
イベントタイプ「$decision」を設定します。 |
||
UserId | userId | 半角英数記号500桁
ユーザID Siftにデバイス情報を送信する際に設定した_user_idを設定します。 |
||
OrderID | orderID | 半角英数記号27桁
オーダーID $create_order、$transactionイベント実行時のオーダーIDを設定します。 |
||
DecisionId | decisionId | 必須
デシジョンID デシジョンを識別する為のIDを設定します。 |
||
Source | source | 必須
デシジョンの出典 デシジョンの出典を設定します。 |
||
Analyst | analyst |
分析者 デシジョンを適用した分析者を設定します。 |
||
Time | time |
デシジョン適用日時デシジョンが適用された日時をyyyyMMddhhmmssで設定します。過去のデータをSiftに送信する埋め戻しを行う場合に必要になります。 |
||
Description | description | 512桁
デシジョン説明デシジョンについての説明を設定します。 |
||
SiftOrderID | siftOrderID | 半角英数記号45桁
SiftオーダーID $create_order、$transactionイベント実行時のSiftオーダーIDを設定します。 |
||
ClientField1 | clientField1 | 全半角100バイト
加盟店自由項目1
|
||
ClientField2 | clientField2 | 全半角100バイト
加盟店自由項目2
|
||
ClientField3 | clientField3 | 全半角100バイト
加盟店自由項目3
|
※1:$create_orderまたは$transaction実行時のオーダーID、SiftオーダーIDのいずれかを
指定してください。ユーザIDを指定しない場合は、最新のユーザIDが設定されます。
/payment/SiftEvents.json
{
"shopID":"tshop11223344",
"shopPass":"PASSWORD",
"type":"$decision",
"decisionId":"order_looks_bad_payment_abuse",
"source":"MANUAL_REVIEW",
"analyst":"analyst@example.com",
"description":"User linked to three other payment abusers and ordering high value items",
"siftOrderID":"20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a3"
}
/payment/SiftEvents.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&Type=$decision&DecisionId=order_looks_bad_payment_abuse&Source=MANUAL_REVIEW&Analyst=analyst@example.com&Description=User linked to three other payment abusers and ordering high value items&SiftOrderID=20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a
レスポンス
正常
SiftOrderID | siftOrderID | 必須 半角英数記号45桁
SiftオーダーID対象のSiftオーダーIDを返却します。 |
||
---|---|---|---|---|
PaymentAbuseScore | paymentAbuseScore | 必須
決済不正使用スコア値は返却されません。 |
{
"siftOrderID": "20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a",
"paymentAbuseScore": ""
}
SiftOrderID=20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a&PaymentAbuseScore=
{
"errCode":"E01",
"errInfo":"E01040001"
}
ErrCode=E01&ErrInfo=E01040001
SiftScore スコア照会
判定済み取引の最新のスコアを返却します。Siftへのスコア照会は行いません。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||
OrderID | orderID | 半角英数記号27桁
オーダーID $create_order、$transactionイベント実行時のオーダーIDを設定します。 |
||
SiftOrderID | siftOrderID | 半角英数記号45桁
SiftオーダーID $create_order、$transactionイベント実行時のSiftオーダーIDを設定します。 |
※1:$create_orderまたは$transaction実行時のオーダーID、SiftオーダーIDの
いずれかを指定してください。
/payment/SiftScore.json
{
"shopID": "tshop11223344",
"shopPass": "PASSWORD",
"siftOrderID":"20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a"
}
/payment/SiftScore.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&SiftOrderID=20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a
レスポンス
正常
SiftOrderID | siftOrderID | 必須 半角英数記号45桁
SiftオーダーID
|
||
---|---|---|---|---|
Type | type | 必須 半角英数記号13桁
イベントタイプ
|
||
ProcessDate | processDate | 必須 半角数字14桁 固定
処理日時 処理を実施した日時を返却します。 |
||
UserId | userId | 必須 半角英数記号500桁
ユーザID
|
||
SessionId | sessionId | 半角英数記号500桁
セッションID
|
||
TransactionId | transactionId | 半角英数45桁
トランザクションID
|
||
Status | status | 必須 半角英字7桁
通信結果 SUCCESS:成功 |
||
OrderID | orderID | 半角英数記号27桁
オーダーID
|
||
PayType | payType | 半角英数30桁
決済方法
|
||
PaymentAbuseScore | paymentAbuseScore | 半角数字3桁
決済不正使用スコア
|
||
ClientField1 | clientField1 | 全半角100バイト
加盟店自由項目1
|
||
ClientField2 | clientField2 | 全半角100バイト
加盟店自由項目2
|
||
ClientField3 | clientField3 | 全半角100バイト
加盟店自由項目3
|
※1 スコア判定時にSiftからエラーが返却された場合、FAILとなります。
FAILの場合、スコアは返却しません。
{
"siftOrderID":"20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a",
"type":"$transaction",
"processDate":"20200101182154",
"userId":"billy_jones_301",
"sessionId":"gigtleqddo84l8cm15qe4il",
"transactionId":"20200101-dda72a91-ad5c-4dc3-bc1a-3a7bcd2ab013",
"status":"SUCCESS",
"orderID":"ORDER0000001",
"payType":"Credit",
"paymentAbuseScore":"53",
"clientField1":"",
"clientField2":"",
"clientField3":""
}
SiftOrderID=20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a&Type=$transaction&ProcessDate=20200101182154&UserId=billy_jones_301&SessionId=gigtleqddo84l8cm15qe4il&TransactionId=20200101-dda72a91-ad5c-4dc3-bc1a-3a7bcd2ab013&Status=SUCCESS&OrderID=ORDER0000001&PayType=Credit&PaymentAbuseScore=53&ClientField1=&ClientField2=&ClientField3=
{
"errCode":"E01",
"errInfo":"E01040001"
}
ErrCode=E01&ErrInfo=E01040001